Finance APIs
List of bank statements
| HTTP method | GET |
| URI | https://api.rambase.net/finance/bank-statements |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 495, version 21 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| Attention() Named filter | Bank statement that need attention (status less than 8) |
| Confirmed() Named filter | Confirmed bank statements (status 9) |
| Deviations() Named filter | Bank statements with deviations |
| Reconciled() Named filter | Reconciled bank statements (status equal 8) |
| BankAccountId Integer | Bank account identifier. |
| BankAccountNumber String | Account number used to identify the bank account. |
| BankAmount Decimal | Total transaction amount. |
| BankStatementId Integer | Bank statement identifier. |
| BookingDate Date | Booking date of the bank statement. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ClosingBalance Decimal | Closing balance of bank statement. |
| DeviationAmount Decimal | Total deviation amount. |
| ErrorMessage String | Shows a message of validation error for this document. |
| IsExcludedFromAutomaticReconciliation Boolean | Indicates if the bank statement should be excluded from automatic reconciliation. |
| OpeningBalance Decimal | Opening balance of bank statement. |
| PaymentAmount Decimal | Total payment amount. |
| SortIndex Integer | Sorting index of bank statement. |
| Status Integer | Status of bank statement. |
Read more about filters and sorting on how to use sortable parameters
| BankAccountId Integer | Bank account identifier |
| BankAccountNumber String | Account number used to identify the bank account |
| BankAmount Decimal | Total transaction amount |
| BankStatementId Integer | Bank statement identifier |
| BookingDate Date | Booking date of the bank statement |
| ClosingBalance Decimal | Closing balance of bank statement |
| DeviationAmount Decimal | Total deviation amount |
| ErrorMessage String | Shows a message of validation error for this document |
| IsExcludedFromAutomaticReconciliation Boolean | Indicates if the bank statement should be excluded from automatic reconciliation |
| OpeningBalance Decimal | Opening balance of bank statement |
| PaymentAmount Decimal | Total payment amount |
| SortIndex Integer | Sorting index of bank statement |
| Status Integer | Status of bank statement |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>BankStatementId
Bank statement identifier
>{Integer}</BankStatementId>BookingDate
Booking date of the bank statement
>{Date}</BookingDate>ErrorMessage
Shows a message of validation error for this document
Possible domain values can be found here
>{String}</ErrorMessage>SortIndex
Sorting index of bank statement
>{Integer}</SortIndex>IsExcludedFromAutomaticReconciliation
Indicates if the bank statement should be excluded from automatic reconciliation
>{Boolean}</IsExcludedFromAutomaticReconciliation>BankAccountId
Bank account identifier
>{Integer}</BankAccountId>Name
Name of bank account
>{String}</Name>AccountNumber
Account number used to identify the bank account
>{String}</AccountNumber>Currency
Currency used for the bank account
>{String}</Currency>BankAccountLink
Bank reference
>{String}</BankAccountLink>AccountingPeriodId
Accounting period identifier
>{Integer}</AccountingPeriodId>Period
Accounting period
>{Integer}</Period>AccountingPeriodLink
Accounting period reference
>{String}</AccountingPeriodLink>UserId
User identifier
>{Integer}</UserId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>OpeningBalance
Opening balance of bank statement
>{Decimal}</OpeningBalance>ClosingBalance
Closing balance of bank statement
>{Decimal}</ClosingBalance>BankAmount
Total transaction amount
>{Decimal}</BankAmount>PaymentAmount
Total payment amount
>{Decimal}</PaymentAmount>DeviationAmount
Total deviation amount
>{Decimal}</DeviationAmount>NotReconciledAmount
Amount of bank statement transactions which are not reconciled
>{Decimal}</NotReconciledAmount>BankStatementLink
Bank statement reference
>{String}</BankStatementLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>CreatedAt
Date and time of creation
": "{Datetime}",BankStatementId
Bank statement identifier
": "{Integer}",Status
Status of bank statement
Possible domain values can be found here
": "{Integer}",BookingDate
Booking date of the bank statement
": "{Date}",ErrorMessage
Shows a message of validation error for this document
Possible domain values can be found here
": "{String}",SortIndex
Sorting index of bank statement
": "{Integer}",IsExcludedFromAutomaticReconciliation
Indicates if the bank statement should be excluded from automatic reconciliation
": "{Boolean}",BankAccountId
Bank account identifier
": "{Integer}",Name
Name of bank account
": "{String}",AccountNumber
Account number used to identify the bank account
": "{String}",Currency
Currency used for the bank account
": "{String}",BankAccountLink
Bank reference
": "{String}"AccountingPeriodId
Accounting period identifier
": "{Integer}",Period
Accounting period
": "{Integer}",AccountingPeriodLink
Accounting period reference
": "{String}"UserId
User identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",UserLink
User reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",OpeningBalance
Opening balance of bank statement
": "{Decimal}",ClosingBalance
Closing balance of bank statement
": "{Decimal}",BankAmount
Total transaction amount
": "{Decimal}",PaymentAmount
Total payment amount
": "{Decimal}",DeviationAmount
Total deviation amount
": "{Decimal}",NotReconciledAmount
Amount of bank statement transactions which are not reconciled
": "{Decimal}"BankStatementLink
Bank statement reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101814 HTTP 404 | Employee not found |